<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>PaneInformation (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="PaneInformation (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PaneInformation.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/util/LazilyConcatenatedByteArray.html" title="class in org.apache.poi.hssf.util"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hssf/util/Region.html" title="class in org.apache.poi.hssf.util"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/util/PaneInformation.html" target="_top">FRAMES</a></li>
<li><a href="PaneInformation.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hssf.util</p>
<h2 title="Class PaneInformation" class="title">Class PaneInformation</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.hssf.util.PaneInformation</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>PaneInformation</strong>
extends java.lang.Object</pre>
<div class="block">Holds information regarding a split plane or freeze plane for a sheet.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_LOWER_LEFT">PANE_LOWER_LEFT</a></strong></code>
<div class="block">Constant for active pane being the lower left</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_LOWER_RIGHT">PANE_LOWER_RIGHT</a></strong></code>
<div class="block">Constant for active pane being the lower right</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_UPPER_LEFT">PANE_UPPER_LEFT</a></strong></code>
<div class="block">Constant for active pane being the upper left</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_UPPER_RIGHT">PANE_UPPER_RIGHT</a></strong></code>
<div class="block">Constant for active pane being the upper right</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PaneInformation(short, short, short, short, byte, boolean)">PaneInformation</a></strong>(short&nbsp;x,
               short&nbsp;y,
               short&nbsp;top,
               short&nbsp;left,
               byte&nbsp;active,
               boolean&nbsp;frozen)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#getActivePane()">getActivePane</a></strong>()</code>
<div class="block">Returns the active pane</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#getHorizontalSplitPosition()">getHorizontalSplitPosition</a></strong>()</code>
<div class="block">Returns the horizontal position of the split.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#getHorizontalSplitTopRow()">getHorizontalSplitTopRow</a></strong>()</code>
<div class="block">For a horizontal split returns the top row in the BOTTOM pane.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#getVerticalSplitLeftColumn()">getVerticalSplitLeftColumn</a></strong>()</code>
<div class="block">For a vertical split returns the left column in the RIGHT pane.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#getVerticalSplitPosition()">getVerticalSplitPosition</a></strong>()</code>
<div class="block">Returns the vertical position of the split.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#isFreezePane()">isFreezePane</a></strong>()</code>
<div class="block">Returns true if this is a Freeze pane, false if it is a split pane.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="PANE_LOWER_RIGHT">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PANE_LOWER_RIGHT</h4>
<pre>public static final&nbsp;byte PANE_LOWER_RIGHT</pre>
<div class="block">Constant for active pane being the lower right</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.util.PaneInformation.PANE_LOWER_RIGHT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PANE_UPPER_RIGHT">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PANE_UPPER_RIGHT</h4>
<pre>public static final&nbsp;byte PANE_UPPER_RIGHT</pre>
<div class="block">Constant for active pane being the upper right</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.util.PaneInformation.PANE_UPPER_RIGHT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PANE_LOWER_LEFT">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PANE_LOWER_LEFT</h4>
<pre>public static final&nbsp;byte PANE_LOWER_LEFT</pre>
<div class="block">Constant for active pane being the lower left</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.util.PaneInformation.PANE_LOWER_LEFT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PANE_UPPER_LEFT">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PANE_UPPER_LEFT</h4>
<pre>public static final&nbsp;byte PANE_UPPER_LEFT</pre>
<div class="block">Constant for active pane being the upper left</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hssf.util.PaneInformation.PANE_UPPER_LEFT">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="PaneInformation(short, short, short, short, byte, boolean)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PaneInformation</h4>
<pre>public&nbsp;PaneInformation(short&nbsp;x,
               short&nbsp;y,
               short&nbsp;top,
               short&nbsp;left,
               byte&nbsp;active,
               boolean&nbsp;frozen)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getVerticalSplitPosition()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVerticalSplitPosition</h4>
<pre>public&nbsp;short&nbsp;getVerticalSplitPosition()</pre>
<div class="block">Returns the vertical position of the split.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>0 if there is no vertical spilt,
         or for a freeze pane the number of columns in the TOP pane,
         or for a split plane the position of the split in 1/20th of a point.</dd></dl>
</li>
</ul>
<a name="getHorizontalSplitPosition()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHorizontalSplitPosition</h4>
<pre>public&nbsp;short&nbsp;getHorizontalSplitPosition()</pre>
<div class="block">Returns the horizontal position of the split.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>0 if there is no horizontal spilt,
         or for a freeze pane the number of rows in the LEFT pane,
         or for a split plane the position of the split in 1/20th of a point.</dd></dl>
</li>
</ul>
<a name="getHorizontalSplitTopRow()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHorizontalSplitTopRow</h4>
<pre>public&nbsp;short&nbsp;getHorizontalSplitTopRow()</pre>
<div class="block">For a horizontal split returns the top row in the BOTTOM pane.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>0 if there is no horizontal split, or the top row of the bottom pane.</dd></dl>
</li>
</ul>
<a name="getVerticalSplitLeftColumn()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVerticalSplitLeftColumn</h4>
<pre>public&nbsp;short&nbsp;getVerticalSplitLeftColumn()</pre>
<div class="block">For a vertical split returns the left column in the RIGHT pane.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>0 if there is no vertical split, or the left column in the RIGHT pane.</dd></dl>
</li>
</ul>
<a name="getActivePane()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActivePane</h4>
<pre>public&nbsp;byte&nbsp;getActivePane()</pre>
<div class="block">Returns the active pane</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the active pane.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_LOWER_RIGHT"><code>PANE_LOWER_RIGHT</code></a>, 
<a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_UPPER_RIGHT"><code>PANE_UPPER_RIGHT</code></a>, 
<a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_LOWER_LEFT"><code>PANE_LOWER_LEFT</code></a>, 
<a href="../../../../../org/apache/poi/hssf/util/PaneInformation.html#PANE_UPPER_LEFT"><code>PANE_UPPER_LEFT</code></a></dd></dl>
</li>
</ul>
<a name="isFreezePane()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isFreezePane</h4>
<pre>public&nbsp;boolean&nbsp;isFreezePane()</pre>
<div class="block">Returns true if this is a Freeze pane, false if it is a split pane.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PaneInformation.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/util/LazilyConcatenatedByteArray.html" title="class in org.apache.poi.hssf.util"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hssf/util/Region.html" title="class in org.apache.poi.hssf.util"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/util/PaneInformation.html" target="_top">FRAMES</a></li>
<li><a href="PaneInformation.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
